Skip to content

List replays

GET
/replays/{groupingProp}

List replay groups for a metadata key. Each replay group represents one metadata value and one or more recordings sharing that value.

Authorizations

Private API Key
Bearer token for authentication. Use your private API key as the token.

Parameters

Path Parameters

groupingProp*

The metadata key used to group recordings into replays

Type
string
Required
Example"sessionId"
Min Length
1
Max Length
100

Query Parameters

limit

Maximum number of replays to return (1-100, default: 50)

Type
string
Example"50"
offset

Number of replays to skip (default: 0)

Type
string
Example"0"
includeSignedUrls

Include presigned replay URLs in the response.

Type
boolean
Exampletrue

Responses

Successfully listed replays grouped by metadata value

application/json
JSON
{
  
"groupingProp": "userId",
  
"replays": [
  
  
{
  
  
  
"replayValue": "user-123",
  
  
  
"recordingCount": 5,
  
  
  
"latestTimestamp": 1234567890000,
  
  
  
"links": {
  
  
  
  
"replay": "/replays/userId/user-123",
  
  
  
  
"replaySigned": "/replays/userId/user-123?tenantId=tenant-abc&expires=1735689600&keyId=key-2024-12&signature=a1b2c3..."
  
  
  
}
  
  
}
  
]
}

Playground

Server
Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI